widgets.brease.ToggleButton

Widget Description

short: Umschalten zwischen true/false
de: Schaltet einen Wert zwischen true und false wenn der Benutzer darauf klickt
en: Toggles a value between true and false when the user clicks it

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
breakWord Allows lines to be broken within words if an otherwise unbreakable string is too long to fit. Behavior Boolean false false false false false false true
draggable Make widget draggable. Behavior Boolean false false false false false false true
ellipsis If true, overflow of text is symbolized with an ellipsis. This option has no effect, if wordWrap = true. Behavior Boolean false false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
image Path to an optional image. Appearance ImagePath true false false false false true
imageAlign Position of image relative to text. Appearance brease.enum.ImageAlign left false false false false false true
mouseDownImage Path to an optional image to be shown in 'checked' state. Appearance ImagePath true false false false false true
mouseDownText Text which is displayed in the widget when pressed Appearance String true false false true false true
multiLine If true, more than one line is possible. Text will wrap when necessary (if property wordWrap is set to true) or at explicit line breaks (\n). If false, text will never wrap to the next line. The text continues on the same line. Behavior Boolean false false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer 0 false false false false false true
text Text which is displayed in the widget Appearance String true false false true false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
useSVGStyling Define if the image stylings (i.e imageColor) are applied - only valid when SVG Images are used. Appearance Boolean true false false false false false true
value Represents the boolean state of the element. Data Boolean false true false false false true true
visible change visibility Behavior Boolean true true false false false false true
wordWrap If true, text will wrap when necessary. This property has no effect, if multiLine=false Behavior Boolean false false false false false false true
imageHeight height of the image ImageSize 0 false false false true true
imageWidth width of the image ImageSize 0 false false false true true
maxHeight maximum outer height of widget Size 0 false false false true true
minHeight minimum outer height of widget Size 0 false false false true true
maxWidth maximum outer width of widget Size 0 false false false true true
minWidth minimum outer width of widget Size 0 false false false true true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget AutoSize 30 false false false true true
width outer width of widget AutoSize 100 false false false true true

Styleable Properties

name type description defaultValue
imageColor Color

Color of the image - only apply if a SVG image is used

 #000000
mouseDownImageColor Color

Color of the image - only apply if a SVG image is used

 #000000
disabledImageColor Color

Color of the image - only apply if a SVG image is used

 #000000
borderStyle BorderStyle

Style of the Border of the widget

 solid
borderWidth PixelValCollection

Sets the width of the border. For further information, please check its type

 2px
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners. For further information, please check its type

 0px
backColor Color

Sets the background color of the widget

 #DBDBDB
disabledBackColor Color

Sets the background color when disabled

 #F1F1F1
backGroundGradient Gradient

Background as a gradient
disabledBackGroundGradient Gradient

Background as a gradient
mouseDownBackGroundGradient Gradient

Background as a gradient when widget is clicked
backGround ImagePath

Sets the path for an image as background
borderColor ColorCollection

Sets the border color of the widget. For further information, please see its type

 #5B7C70
disabledBorderColor ColorCollection

Sets the color of the border when disabled

 #FFFFFF #C8C8C8 #C8C8C8 #FFFFFF
textColor Color

Sets the color of the text when enabled

 #000000
disabledTextColor Color

Sets the color of the text when disabled

 #989898
mouseDownBorderColor ColorCollection

border color when the widget is pressed

 #FD7B01
mouseDownBorderWidth PixelValCollection

border width when widget is clicked

 2px
mouseDownBackColor Color

back color when the widget is pressed

 #DBDBDB
mouseDownTextColor Color

text color when widget is clicked

 #000000
textAlign brease.enum.TextAlign

Alignment of the text

 center
opacity Opacity

Opacity of the widget

 1
rotation Rotation

Rotation of widget.

 0deg
fontSize PixelVal

Fontsize of the text in pixel

 12px
fontName FontName

Fontname of the text

 Arial
bold Boolean

If true font style is bold

 false
italic Boolean

If true font style is italic

 false
padding Padding

Padding of the Widget

 0px 10px
margin Margin

Margin of the Widget

 0px
shadow Shadow

Shadow of the Widget

 none
mouseDownShadow Shadow

Shadow of the Widget when the widget clicked

 none
checkedBackColor Color

back color when the widget is checked

 #DBDBDB
checkedTextColor Color

text color when the widget is checked

 #000000
checkedImageColor Color

Color of the image when the the widget is checked - only apply if a SVG image is used

 #000000
disabledCheckedTextColor Color

text color when the widget is checked and disabled

 #000000
disabledCheckedImageColor Color

Color of the image when the the widget is checked - only apply if a SVG image is used

 #000000
checkedBorderColor ColorCollection

border color when the widget is checked

 #FD7B01
disabledCheckedBackColor Color

back color when the widget is checked and disabled

 #F1F1F1
disabledCheckedBorderColor ColorCollection

border color when the widget is checked and disabled

 #FFFFFF #C8C8C8 #C8C8C8 #FFFFFF
checkedBackGroundGradient Gradient

Background as a gradient
disabledCheckedBackGroundGradient Gradient

Background as a gradient

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DoubleClick Fired when element has double click.
  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
MouseDown Fired when widget enters mouseDown state
  • horizontalPos: String

    horizontal position of mouse in pixel i.e '10px'

  • verticalPos: String

    vertical position of mouse in pixel i.e '10px'

MouseUp Fired when widget enters mouseUp state
  • horizontalPos: String

    horizontal position of mouse in pixel i.e '10px'

  • verticalPos: String

    vertical position of mouse in pixel i.e '10px'

OnDragEnd Fired when element has OnDragEnd.
  • contentId: String

    content id of the widget where the drag operation has ended

  • widgetId: String

    id of the widget where the drag operation has ended

OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDragStart Fired when element has OnDragStart.
  • contentId: String

    content id of the widget where the drag operation has been started

  • widgetId: String

    id of the widget where the drag operation has been started

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

ValueChanged Fired when the status of the widget is changed by user interaction
  • newValue: Integer

  • newValueBool: Boolean

  • newValueInteger: Integer

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
GetValueBool Get value dependent on state. false -> not checked, true -> checked.
GetValueInteger Get value dependent on state0 -> not checked, 1 -> checked.
RemoveImage Remove an image.
RemoveMouseDownText Remove mouseDownText.
RemoveText Remove text.
SetEnable Sets the state of property «enable»
  • value: Boolean

SetImage Sets an image.
  • image: ImagePath

SetMouseDownImage Sets the image when mouse down
  • mouseDownImage: ImagePath

SetMouseDownText Sets the visible text for pressed state. This method can remove an optional textkey.
  • text: String

  • (optional) keepKey: Boolean

    Set true, if textkey should not be removed

SetStyle
  • value: StyleReference

SetText Sets the visible text. This method can remove an optional textkey.
  • text: String

  • (optional) keepKey: Boolean

    Set true, if textkey should not be removed

SetValue Toggle button dependent of a value. This method is used for binding.
  • value: Integer

SetValueBool Toggle button dependent of a value. false -> not checked, true -> checked.
  • value: Boolean

SetValueInteger Toggle button dependent of a value. 0 -> not checked, 1 -> checked.
  • value: Integer

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip